Skip to main content
Feedback

<mdm:fields> element structure

The <mdm:fields> element corresponds to the Fields tab in a model page.

  • <mdm:fields> has a child <mdm:field> element representing each of the model’s fields.

  • <mdm:fields> has a child <mdm:fieldGroup> element representing each of the model’s field groups.

This example shows the high-level structure of the <mdm:fields> element:

<mdm:fields>
   <!-- text field -->
   <mdm:field name="" repeatable="false" required="" type="STRING" uniqueId="" minLength="" maxLength="" regex=""/>
   <!-- collection field -->
   <mdm:field name="" repeatable="true" required="" type="STRING" uniqueId="" identifyBy="" collectionTag="" collectionUniqueId=""/>
   <!-- reference field -->
   <mdm:field name="" repeatable="false" required="" type="REFERENCE" uniqueId="" incomingReferenceIntegrity="" outgoingReferenceIntegrity="" referenceUniverseId=""/>
   <!-- collection reference Field -->
   <mdm:field name="" repeatable="true" required="" type="REFERENCE" uniqueId="" identifyBy="" collectionTag="" collectionUniqueId="" incomingReferenceIntegrity="" outgoingReferenceIntegrity="" referenceUniverseId=""/>
   <!-- enumeration field -->
   <mdm:field name="" repeatable="" required="" type="ENUMERATION" uniqueId="">
      <mdm:value></mdm:value>
      .
      .
      .
      <mdm:value></mdm:value>
   </mdm:field>

   <!-- non-repeatable field group -->
   <mdm:fieldGroup name="" repeatable="false" required="" uniqueId="">
      <mdm:field name="" repeatable="false" required="" type="STRING" uniqueId="" minLength="" maxLength="" regex=""/>
      <mdm:field name="" repeatable="true" required="" type="STRING" uniqueId="" identifyBy="" collectionTag="" collectionUniqueId=""/>
      <mdm:field name="" repeatable="false" required="" type="REFERENCE" uniqueId="" incomingReferenceIntegrity="" outgoingReferenceIntegrity="" referenceUniverseId=""/>
      <mdm:field name="" repeatable="true" required="" type="REFERENCE" uniqueId="" identifyBy="" collectionTag="" collectionUniqueId="" incomingReferenceIntegrity="" outgoingReferenceIntegrity="" referenceUniverseId=""/>
   </mdm:fieldGroup>
   <!-- collection (repeatable field group) -->
   <mdm:fieldGroup name="" repeatable="true" required="" uniqueId="" collectionKeys="" identifyBy="" collectionTag="" collectionUniqueId="">
      <mdm:field name="" repeatable="false" required="" type="STRING" uniqueId="NAME" minLength="" maxLength="" regex=""/>
      <mdm:field name="" repeatable="true" required="" type="STRING" uniqueId="" identifyBy="" collectionTag="" collectionUniqueId=""/>
   </mdm:fieldGroup>
</mdm:fields>

<mdm:field>

Field properties are represented by attributes of <mdm:field>.

For a field of any type, <mdm:field> has a uniqueId attribute, the value of which corresponds to the ID shown in the Unique ID column of the fields summary list in the Fields tab in Boomi DataHub. This ID is automatically assigned when creating a field in Boomi DataHub. In a Create Model or Update Model request, the uniqueId attribute is required and must have a unique value. The unique ID value cannot contain spaces, special characters, or lowercase characters.

For a field of any type, the following are additional <mdm:field> attributes, each of which corresponds to a property set in the Add a Field or Field Group dialog and the Modify Field Properties dialog in Boomi DataHub:Field Properties** dialog in :

AttributeCorresponds toValid valuesNotes
nameNameany string, subject to length limitations
repeatableCan Repeattrue, false
requiredRequiredtrue, false
typeType
  • BOOLEAN
  • CLOB
  • DATE
  • DATETIME
  • ENUMERATION
  • FLOAT
  • INTEGER
  • REFERENCE
  • STRING
  • TIME
maskedMasked
  • ALL
  • PARTIAL MASK
  • PARTIAL SHOW
PARTIAL MASK and PARTIAL SHOW are not available for Boolean and Reference field types. ALL is not available for Reference field types. Masked fields set to ALL show five asteriks to represent the masked field, hiding the actual character length.The masked attribute has additional attributes to specify the amount of characters to mask and whether to mask the first, last or both portions of the value. One of these attributes is required when using PARTIAL MASK or PARTIAL SHOW. Read Data masking to learn more

<mdm:field type="STRING">

Example:

<mdm:field name="Web URL" repeatable="false" required="true" type="STRING" uniqueId="WEB_URL" minLength="10" maxLength="100" regex="/^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$/"/>

<mdm:field> of type STRING (a Text field) has additional attributes, each of which corresponds to a property set in the Add a Field or Field Group dialog and the Modify Field Properties dialog in Boomi DataHub:

AttributeCorresponds toValid values
minLengthMinimum Text Lengthinteger
maxLengthMaximum Text Lengthinteger, maximum 255
regexRegular Expressionregular expression

<mdm:field repeatable="true">

Example:

<mdm:field name="Nickname" repeatable="true" required="false" type="STRING" uniqueId="NICKNAMES" identifyBy="KEY" collectionTag="Nicknames" collectionUniqueId="NICKNAMES"/>

<mdm:field> with a repeatable attribute value of true(a collection field) has additional attributes, each of which corresponds to a property set in the Add a Field or Field Group dialog, and the Modify Field Properties dialog in Boomi DataHub:

AttributeCorresponds toValid values
identifyByIdentify ByKEY, OCCURRENCE
collectionTagCollection Tagany string

An additional attribute, collectionUniqueId, is automatically assigned to a collection field upon its creation in Boomi DataHub. Its value does not appear in the fields summary list or a properties dialog.

<mdm:field type="REFERENCE">

Example:

<mdm:field name="manager" repeatable="false" required="false" type="REFERENCE" uniqueId="MANAGER" incomingReferenceIntegrity="true" outgoingReferenceIntegrity="true" referenceUniverseId="a0d2040e-40ac-4d21-97ee-d44f2d72fb22"/>

<mdm:field> of type REFERENCE (a Reference field) has additional attributes, each of which corresponds to a property set in the Add a Field or Field Group dialog and the Modify Field Properties dialog in Boomi DataHub:

AttributeCorresponds toValid values
incomingReferenceIntegrityEnforce Incomingtrue, false
outgoingReferenceIntegrityEnforce Outgoingtrue, false
referenceUniverseIdRefers To Modelsystem ID of the referenced model

<mdm:field type="ENUMERATION">

Example:

<mdm:field name="state" repeatable="false" required="false" type="ENUMERATION" uniqueId="STATE">
   <mdm:value>Alabama</mdm:value>
   <mdm:value>Alaska</mdm:value>
   <mdm:value>American Samoa</mdm:value>
   . . .
   <mdm:value>Wyoming</mdm:value>
   </mdm:field>

Data masking

<mdm:field> attribute PARTIAL MASK has additional attributes, each of which corresponds to a property set in the Add a Field or or Field Group dialog and the Modify Field Properties dialog in Boomi DataHub:

AttributeCorresponds toValid values
firstMaskCharsCountFirst1 through 255. It indicates how many characters to mask starting from the first character.
lastMaskCharsCountLast1 through 255. It indicates how many characters to mask starting from the last character.

<mdm:field masked="PARTIAL MASK">

Example:

<mdm:fieldGroup name="address" repeatable="false" required="false" uniqueId="ADDRESS">
            <mdm:field name="street" repeatable="false" required="false" type="STRING" uniqueId="STREET" masked="PARTIAL MASK" firstMaskCharsCount="2" lastMaskCharsCount ="3"/>
            <mdm:field name="city" repeatable="false" required="false" type="STRING" uniqueId="CITY"/>
    </mdm:fieldGroup>
note

To see masked data, the user needs either the MDM - Reveal Masked Data privilege or the Reveal Masked Data entitlement. Read Setting up user accounts and access to learn more.

<mdm:field> of type ENUMERATION (an Enumeration field) has a child <mdm:value> element representing each enumerated value. <mdm:value> contains the enumerated value.

<mdm:fieldGroup>

<mdm:fieldGroup> has a child <mdm:field> element representing each of the field group’s fields and a child <mdm:fieldGroup> element representing each of the field group’s nested field groups.

This example shows the structure of a non-repeatable field group consisting of two fields:

<mdm:fieldGroup name="Street Address" repeatable="false" required="true" uniqueId="STREET_ADDRESS">
   <mdm:field name="Address 1" repeatable="false" required="true" type="STRING" uniqueId="ADDRESS_1"/>
   <mdm:field name="Address 2" repeatable="false" required="false" type="STRING" uniqueId="ADDRESS_2"/>
</mdm:fieldGroup>

Field group properties are represented by attributes of <mdm:fieldGroup>.

<mdm:fieldGroup> has a uniqueId attribute, the value of which corresponds to the ID shown in the Unique ID column of the fields summary list in the Fields tab in Boomi DataHub. When creating a field group in Boomi DataHub, this ID is automatically assigned. In a Create Model or Update Model request, the uniqueId attribute is required and must have a unique value. The unique ID cannot contain spaces, special characters, or lowercase characters.

For a field group, the following are additional <mdm:fieldGroup> attributes, each of which corresponds to a property set in the Add a Field or Field Group dialog and the Modify Field Group Properties dialog in Boomi DataHub:

AttributeCorresponds toValid values
nameNameany string, subject to length limitations
repeatableCan Repeattrue, false
requiredRequiredtrue, false

<mdm:fieldGroup repeatable="true">

Example:

<mdm:fieldGroup name="website" repeatable="true" required="false" uniqueId="WEBSITES" identifyBy="KEY" collectionTag="websites" collectionUniqueId="WEBSITES" collectionKeys="SITEURL">
   <mdm:field name="sitename" repeatable="false" required="false" type="STRING" uniqueId="SITENAME"/>
   <mdm:field name="siteurl" repeatable="false" required="false" type="REFERENCE" uniqueId="SITEURL" incomingReferenceIntegrity="false" outgoingReferenceIntegrity="false" referenceUniverseId="502a38c3-51d6-45b4-a679-36e6a35207cc"/>
</mdm:fieldGroup>

<mdm:fieldGroup> with a repeatable attribute value of true (a collection) has additional attributes, each of which corresponds to a property set in the Add a Field or Field Group dialog and the Modify Field Group Properties dialog in Boomi DataHub:

AttributeCorresponds toValid values
identifyByIdentify ByKEY, OCCURRENCE
collectionTagCollection Tagany string
collectionKeysCollection KeysComma-delimited <mdm:field> uniqueId attribute values

An additional attribute, collectionUniqueId, is automatically assigned to a collection upon its creation in Boomi DataHub. Its value does not appear in the fields summary list or a properties dialog.

On this Page